package com.wanna.common.doc.document;

import com.wanna.common.doc.entity.ApiInfo;

import java.util.List;

/**
 * 接口文档 接口
 *
 * @author wanna
 * @since 2018-11-25
 */
public interface ApiDoc {

    /**
     * 生产 接口文档
     *
     * @param interfaces 接口
     * @param savePath   保存路径
     * @return 是否成功
     * @throws Exception 失败则抛出异常
     */
    boolean generateDoc(List<ApiInfo> interfaces, String savePath) throws Exception;
}
